home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / cli / Ahelp.lha / Help_Docs < prev    next >
Encoding:
Text File  |  1993-06-07  |  2.1 KB  |  89 lines
  1. AHELP: The AmigaDOS command help utility!
  2. Version 1.2
  3.  
  4. By Joe Cassara
  5.  
  6.  
  7. OVERVIEW:
  8.  
  9.         I'm sure that those of you who have used an IBM system 
  10.     before have noticed that the Amiga has no help command in DOS.
  11.     I've looked for PD versions of this command for the Amiga and
  12.     didn't find any; so I wrote one.  The AHELP system consists of
  13.     the following two files:
  14.  
  15.         HELP -        The main program
  16.                 (Copied to your C: directory by the install 
  17.                  script)
  18.  
  19.         HELP.LIBRARY -     The support file containing the information
  20.                 on the AmigaDOS command set.
  21.                 (Copied to your LIBS: directory by the install
  22.                  script)
  23. INSTALLING:
  24.  
  25.     Simply double click on the INSTALL icon in the AHELP drawer.
  26.     The install script does the rest.
  27.  
  28. USAGE:
  29.  
  30.     Using AHELP is quite easy when in an AmigaShell process:
  31.  
  32.         HELP <command>
  33.         (Displays help on the specified command)
  34.  
  35.         HELP <character>
  36.         (Lists all commands beginning with the specified character)
  37.  
  38.         HELP
  39.         (Lists all commands)
  40.  
  41. ADDING COMMANDS:
  42.  
  43.     To add commands to the 'Help.library', simply load it into
  44.     your favorite text editor (such as MEmacs) and follow this
  45.     entry format:
  46.  
  47.         <command name>
  48.         
  49.                 <help text body>
  50.  
  51.         #
  52.         <command name>
  53.         
  54.                 <help text body>
  55.         
  56.         #
  57.  
  58.         etc...
  59.  
  60.     Note the pound (#) sign at the end of the command blocks.  This
  61.     informs AHELP that it has reached the end of the help text for that
  62.     command.  Without it, AHELP would display the text for every command!
  63.  
  64.     
  65. THE END:
  66.  
  67.     If you have any questions, comments, or ideas on how I can improve 
  68.     AHELP write to:
  69.  
  70.         Joe J. Cassara
  71.         ATTN: AHELP
  72.         541 NW 60 Avenue
  73.         Miami, Fl 33126
  74.  
  75.     If you like this program - hold on a minute...  Even if you DON'T
  76.     like this program, please send me a postcard!  This will help me 
  77.     determine whether I should update the program, and show me where
  78.     the program has traveled.  Thank you for your interest in AHELP 
  79.     and, most of all, the Amiga!
  80.  
  81.         *** DON'T FORGET TO SEND IN YOUR POSTCARD! ***
  82.  
  83.             / / /
  84.                        / / /    - Joe Cassara
  85.               / / /      (jcassar@gate.net)
  86.         \ \ \/ / /        
  87.          \ \/\/    /      January 26, 1994
  88.                   \/\/\/
  89.